package com.danciyixue.boot.dcyx.service;

import com.danciyixue.boot.dcyx.model.entity.Words;
import com.danciyixue.boot.dcyx.model.form.WordsForm;
import com.danciyixue.boot.dcyx.model.query.WordsQuery;
import com.danciyixue.boot.dcyx.model.vo.WordsVO;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;

import java.util.List;

/**
 * 单词信息服务类
 *
 * @author youlaitech
 * @since 2025-06-15 16:23
 */
public interface WordsService extends IService<Words> {

    /**
     *单词信息分页列表
     *
     * @return {@link IPage<WordsVO>} 单词信息分页列表
     */
    IPage<WordsVO> getWordsPage(WordsQuery queryParams);

    /**
     * 获取单词信息表单数据
     *
     * @param id 单词信息ID
     * @return 单词信息表单数据
     */
     WordsForm getWordsFormData(Long id);

    /**
     * 新增单词信息
     *
     * @param formData 单词信息表单对象
     * @return 是否新增成功
     */
    boolean saveWords(WordsForm formData);

    /**
     * 修改单词信息
     *
     * @param id   单词信息ID
     * @param formData 单词信息表单对象
     * @return 是否修改成功
     */
    boolean updateWords(Long id, WordsForm formData);

    /**
     * 删除单词信息
     *
     * @param ids 单词信息ID，多个以英文逗号(,)分割
     * @return 是否删除成功
     */
    boolean deleteWordss(String ids);

    /**
     * 随机获取指定教材的单词
     *
     * @param programId 教材ID
     * @param limit 获取数量
     * @return 单词列表
     */
    List<Words> getRandomWordsByProgramId(Long programId, Integer limit);

    /**
     * 随机获取指定教材的单词，排除指定的单词ID列表
     *
     * @param programId 教材ID
     * @param excludeIds 要排除的单词ID列表
     * @param limit 获取数量
     * @return 单词列表
     */
    List<Words> getRandomWordsByProgramIdExcluding(Long programId, List<Long> excludeIds, Integer limit);

    /**
     * 根据单元ID获取所有单词
     *
     * @param unitId 单元ID
     * @return 单词列表
     */
    List<Words> getWordsByUnitId(Long unitId);

    /**
     * 随机获取指定教材的单词，排除指定单元ID
     *
     * @param programId 教材ID
     * @param excludeUnitId 要排除的单元ID
     * @param limit 获取数量
     * @return 单词列表
     */
    List<Words> getRandomWordsByProgramIdExcludingUnit(Long programId, Long excludeUnitId, Integer limit);

    /**
     * 根据单词ID列表查询单词拼写
     *
     * @param wordIds 单词ID列表
     * @return 单词拼写列表
     */
    List<String> getWordSpellingsByIds(List<Long> wordIds);

}
